Skip to content

Add AGENTS.md with project guidelines for AI coding agents#69

Merged
amrabed merged 2 commits intomainfrom
add-agents-md
Apr 9, 2026
Merged

Add AGENTS.md with project guidelines for AI coding agents#69
amrabed merged 2 commits intomainfrom
add-agents-md

Conversation

@amrabed
Copy link
Copy Markdown
Owner

@amrabed amrabed commented Apr 9, 2026

Summary

Adds AGENTS.md to provide coding guidelines for AI agents (e.g., GitHub Copilot, Cursor, Codex) working in this repository.

What's included

  • Dependencies: Poetry, Pydantic, and Pydantic-settings usage guidelines
  • Testing Guidelines: pytest conventions, mocking with monkeypatch/pytest-mock, and honesty rules
  • Make Targets: Workflow automation via make targets
  • Notes: Python 3.12+ requirement, pyproject.toml/poetry.lock management
  • Coding Conventions:
    • Pydantic Field(description=...) on every field
    • camelCase alias convention with populate_by_name=True and alias_generator=to_camel
    • No model_config class attribute — use keyword arguments on base class
    • Explicit from x import y import style
    • Required if __name__ == "__main__": main() block in every test file

@amrabed amrabed merged commit 2f0cdaa into main Apr 9, 2026
1 check passed
@amrabed amrabed deleted the add-agents-md branch April 9, 2026 23:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant